home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr25 / ibmtrdb.zip / IBMTRDB.TXT < prev    next >
Text File  |  1993-06-08  |  20KB  |  486 lines
  1.  
  2.   This README file contains the following information:
  3.  
  4.   1.0   NDIS Device Driver Overview
  5.  
  6.   2.0   NDIS Device Driver Installation
  7.  
  8.   3.0   NDIS Device Driver Configuration
  9.  
  10.   4.0   NDIS Device Driver Support For Multiple Adapters
  11.  
  12.   5.0   NDIS Device Driver Messages
  13.  
  14.  
  15.   Print Instructions:  This is a flat ASCII file and has no printer controls.
  16.   If you want to print this file, you may want to edit it and add any printer
  17.   control characters or page breaks that are needed.
  18.  
  19.  
  20.   1.0   NDIS Device Driver Overview
  21.   ---------------------------------
  22.  
  23.   An IBM Network Driver Interface Specification (NDIS) OS/2 device driver is
  24.   supplied with the IBM LANStreamer adapter.  This NDIS OS/2 driver supports
  25.   OS/2 versions 1.3 and 2.0.
  26.  
  27.   The device driver as defined in the NDIS specification, functions as a Media
  28.   Access Control (MAC) driver.  MAC drivers are device drivers that interface
  29.   directly to the adapter but do not handle communications protocols.  The
  30.   device driver supports Version 2.01 of the NDIS and includes IBM NDIS
  31.   extensions.  The IBM NDIS extensions are used by the device driver to support
  32.   the IEEE 802.2 CCB Interface through the NDIS interface.  The device driver
  33.   indicates that the IBM NDIS extensions are available by setting the Minor
  34.   NDIS Version to an 02 in the Common Characteristics Table.
  35.  
  36.   The IBM LANStreamer NDIS device driver appears as an 802.5 type of MAC driver.
  37.  
  38.  
  39.   2.0   NDIS Device Driver Installation
  40.   -------------------------------------
  41.  
  42.   This driver diskette has been set up to work correctly with IBM LAPS
  43.   installation and configuration program, IBM LAN Support Program
  44.   installation program (DXMAID), and Microsoft LAN Manager installation
  45.   program (SETUP).  The files that make up the support for the LANStreamer
  46.   adapter are duplicated in different directories on this diskette to
  47.   make installation in each of these environments as easy as possible.
  48.  
  49.   When the LAPS installation program is not used in OS/2, the DEVICE=
  50.   statement must be manually inserted in CONFIG.SYS.  The DEVICE= statement
  51.   for the NDIS device driver must be after the DEVICE= statement for the
  52.   Protocol Manager.  Copy the OS/2 NDIS device driver from the
  53.   Driver diskette to the desired target directory.  Then add a DEVICE=
  54.   statement into the CONFIG.SYS file to start the NDIS device driver
  55.   during system initialization.  An example of a DEVICE= statement for
  56.   the CONFIG.SYS file is:
  57.  
  58.  
  59.         DEVICE=C:\..path..\IBMTRDB.OS2
  60.  
  61.   Also remember to remove any device statements for adapters you are replacing
  62.   with the IBM LANStreamer adapter.
  63.  
  64.  
  65.   3.0   NDIS Device Driver Configuration
  66.   --------------------------------------
  67.  
  68.   The NDIS device driver can be configured using the LAPS installation
  69.   Program for OS/2 or by manually editing the PROTOCOL.INI file.
  70.   A detailed description of configurable parameters follows:
  71.  
  72.  
  73.   NETADDRESS =
  74.           The NetAddress parameter overrides the network address of the
  75.           network adapter card.  The value of this parameter is a hexadecimal
  76.           string of 12 digits and must be enclosed in double quotation
  77.           marks.  The characters must be within the range X'400000000000'
  78.           through X'7FFFFFFFFFFF'.  If you do not assign a locally
  79.           administered address, the adapter uses the universally
  80.           administered address.
  81.  
  82.           The address must be unique among all other network adapter
  83.           addresses on the network.
  84.  
  85.           EXAMPLE:  NETADDRESS = "400100001234"
  86.  
  87.  
  88.   MAXTRANSMITS =
  89.           The MaxTransmits parameter specifies the maximum number of transmit
  90.           queue entries to be used by the adapter driver.  The network
  91.           adapter driver allocates approximately 260 bytes for each transmit
  92.           queue entry.  The value of this parameter should be high enough to
  93.           accommodate the sum of all Maximum Number of Queued Transmits
  94.           parameter values specified for all protocol drivers using the adapter
  95.           concurrently.  A value from 2 to 512 queues may be specified.
  96.           If the parameter is not specified, a value of 31 is used.
  97.  
  98.           EXAMPLE:  MAXTRANSMITS = 32
  99.  
  100.  
  101.   SIZWORKBUF =
  102.           The SizWorkBuf parameter specifies the size of the receive buffers.
  103.           A receive buffer can be from 96 to 18000 bytes long.  The default
  104.           receive buffer size is 2048 bytes.  Please refer to the MinRcvBuffs
  105.           parameter to understand the relationship between these two parameters.
  106.  
  107.           EXAMPLE:  SIZWORKBUF = 4096
  108.  
  109.  
  110.   MINRCVBUFFS =
  111.           The MinRcvBuffs parameter specifies the minimum number of receive
  112.           buffers that are allocated by the network adapter driver.  The
  113.           value specified for MinRcvBuffs multiplied by the value specified
  114.           for SizWorkBuf must be greater than the size of the largest frame
  115.           to be received from the network.  For a 4Mbps network the maximum
  116.           length frame size is 4500 bytes.  For a 16Mbps network the maximum
  117.           length frame size is 18000 bytes.  From 2 to 512 receive buffers
  118.           may be specified.  A default of 20 buffers will be used if the
  119.           parameter is not specified.
  120.  
  121.           EXAMPLE:  MINRCVBUFFS = 32
  122.  
  123.  
  124.   MULTICASTNUM =
  125.           The MulticastNum parameter specifies the maximum number of group
  126.           addresses to be supported by the network adapter driver.  The
  127.           network adapter driver can support from 1 to 256 group addresses.
  128.           If this parameter is not specified, a default of 1 will be used.
  129.  
  130.           EXAMPLE:  MULTICASTNUM = 256
  131.  
  132.  
  133.   ENABLETXEOFINT =
  134.           The EnableTxEofInt parameter specifies whether the transmit end
  135.           of frame interrupt should be enabled.  A value of 1 indicates that
  136.           transmit end of frame interrupt will be recognized by the interrupt
  137.           handler.  A value of 0 indicates that the transmit end of frame
  138.           should not be recognized by the interrupt handler.  A value of
  139.           0 may be desireable in some environments (such as a server) to reduce
  140.           the number of times the interrupt handler is invoked.  If this
  141.           parameter is not specified, the transmit end of frame interrupt
  142.           is enabled.
  143.  
  144.           EXAMPLE: ENABLETXEOFINT = 0
  145.  
  146.  
  147.   LOOPBACK =
  148.           The LoopBack parameter is used to determine whether loopback is to
  149.           be supported by the adapter or handled by the protocol stack.
  150.           If this parameter is set to 0, then frames transmitted by this
  151.           station, that would have been received by this station, must be
  152.           looped back by the protocol stack.  If this parameter is set to 1,
  153.           then loopback will be handled by the adapter and frames transmitted
  154.           by this station, addressed to this station, will be received.  If
  155.           not specified, loopback will be set by the driver to a 1 unless
  156.           the adapter is operating in a 16 bit bus slot, or is a 16 bit adapter,
  157.           and is operating at 16 Mbps.  A value of 0 is used in this situation
  158.           because some machines do not have sufficient bus bandwidth to
  159.           handle 16Mbps doing simultaneous transmits and receives.
  160.  
  161.           EXAMPLE: LOOPBACK = 1
  162.  
  163.  
  164.  
  165.   When the LAPS installation program is not used to configure
  166.   the NDIS device driver, the NDIS device driver section of PROTOCOL.INI
  167.   can be created manually. An example of a PROTOCOL.INI section for the
  168.   NDIS device driver follows.
  169.  
  170.  
  171.                      [IBMTRDB_NIF]
  172.  
  173.                        Drivername = IBMTRDB$
  174.  
  175.                        NetAddress = "400001020304"
  176.  
  177.  
  178.  
  179.   The desired protocol driver(s) must be "bound" to the NDIS device driver
  180.   by manually editing the BINDINGS= statement of those protocol drivers.
  181.   An example follows:
  182.  
  183.  
  184.                      [PROTOCOL_DRIVER_ABC]
  185.  
  186.                        Bindings = IBMTRDB_NIF
  187.  
  188.  
  189.  
  190.  
  191.   4.0   NDIS Device Driver Support For Multiple Adapters
  192.   -------------------------------------------------
  193.  
  194.   When more than one adapter is installed in the same system, a single
  195.   device statement is used in CONFIG.SYS.
  196.  
  197.  
  198.       CONFIG.SYS:    DEVICE=C:\..path..\IBMTRDB.OS2
  199.  
  200.  
  201.   Multiple incidences are created within PROTOCOL.INI.
  202.   If you are manually configuring, example PROTOCOL.INI entries follow:
  203.  
  204.  
  205.       PROTOCOL.INI:  [PROTOCOL_DRIVER_ABC]
  206.  
  207.                        Bindings = IBMTRDB_NIF, IBMTRDB1_NIF
  208.  
  209.                      [IBMTRDB_NIF]
  210.  
  211.                        Drivername = IBMTRDB$
  212.  
  213.                        NetAddress = "400001020304"
  214.  
  215.                      [IBMTRDB1_NIF]
  216.  
  217.                        Drivername = IBMTRDB$
  218.  
  219.                        NetAddress = "400001020305"
  220.  
  221.  
  222.  
  223.  
  224.  
  225.   5.0   NDIS Device Driver Messages
  226.   ---------------------------------
  227.  
  228.   -----------------------------------------------------------------------------
  229.   LT60008E: THE PARAMETER SPECIFIED IN PROTOCOL.INI FOR KEYWORD 'KEYWORD' IS
  230.             NOT THE PROPER CHARACTER TYPE.
  231.  
  232.   CAUSE:  The value provided for the keyword in the IBMTRDB module in the
  233.   PROTOCOL.INI file is not the correct type.
  234.  
  235.   USER ACTION:  Change the value in PROTOCOL.INI to the correct type for the
  236.   parameter.
  237.  
  238.   -----------------------------------------------------------------------------
  239.   LT60009E: AN UNRECOVERABLE ERROR OCCURRED IN THE IBM LANSTREAMER ADAPTER
  240.             NDIS DEVICE DRIVER PROGRAM.
  241.  
  242.   CAUSE:  An internal software error occurred.
  243.  
  244.   USER ACTION:  Contact your vendor sales representative.
  245.  
  246.   -----------------------------------------------------------------------------
  247.   LT60010E: ALL IBM LANSTREAMER ADAPTERS MUST BE SET TO THE SAME INTERRUPT LEVEL.
  248.  
  249.  
  250.   CAUSE:  One or more IBM LANStreamer adapters are set to a different
  251.   interrupt level.  To function properly, these adapters must all be set to
  252.   the same interrupt levels.
  253.  
  254.   USER ACTION:  Use the reference diskette that came with your computer to
  255.   ensure that all IBM LANStreamer adapters are set to the same interrupt
  256.   level.
  257.  
  258.   -----------------------------------------------------------------------------
  259.   LT60011I: THE UNIVERSALLY ADMINISTERED ADDRESS OF THE IBM LANSTREAMER
  260.             IS 'ADDRESS'.
  261.  
  262.   CAUSE: The universally administered address of the adapter installed in
  263.   the computer is displayed in this message.
  264.  
  265.   USER ACTION: None.
  266.  
  267.   -----------------------------------------------------------------------------
  268.   LT60012I: THE IBM LANSTREAMER ADAPTER IS USING A LOCALLY ADMINISTERED ADDRESS
  269.             OF 'ADDRESS'.
  270.  
  271.   CAUSE:  The locally administered address for the IBM LANStreamer adapter
  272.   installed in the computer is displayed in this message.
  273.  
  274.   USER ACTION:  None.
  275.  
  276.   -----------------------------------------------------------------------------
  277.   LT60014E: THE PARAMETER VALUES HAVE FORCED THE CONTROL-BLOCK SIZE TO
  278.             EXCEED THE ALLOWABLE LIMIT.
  279.  
  280.   CAUSE:  The parameters specified require more space for processing than
  281.   can be handled.  The maximum allowable control-block size is 64KB.
  282.  
  283.   USER ACTION:  Reduce the value specified for the MAXTRANSMITS or MINRCVBUFFS
  284.   parameter to change the amount of storage required for the control-blocks.
  285.  
  286.   The control-block area can be computed using the following formula:
  287.   1698 + (190 * MAXTRANSMITS) + (256 * MINRCVBUFFS)
  288.  
  289.   The control-block work area must be less than 64KB.
  290.  
  291.   -----------------------------------------------------------------------------
  292.   LT60015E: THE ADAPTER IS NOT RESPONDING.
  293.  
  294.   CAUSE: The adapter is not responding to a request to initialize.
  295.  
  296.   USER ACTION: Run the hardware diagnostics for the IBM LANStreamer Adapter.
  297.   Contact your vendor sales representative.
  298.  
  299.   -----------------------------------------------------------------------------
  300.   -----------------------------------------------------------------------------
  301.   LT60016I: THE IBM LANSTREAMER ADAPTER IS OPERATING AT A DATA RATE OF 4 MBPS.
  302.  
  303.   USER ACTION: None
  304.  
  305.   -----------------------------------------------------------------------------
  306.   LT60017I: THE IBM LANSTREAMER ADAPTER IS OPERATING AT A DATA RATE OF 16 MBPS.
  307.  
  308.   USER ACTION: None
  309.  
  310.   -----------------------------------------------------------------------------
  311.   LT60025W: DUPLICATE DEVICE DRIVER STATEMENTS EXIST IN CONFIG.SYS.
  312.  
  313.   CAUSE:  Only one occurrence of the device driver statement for the
  314.   IBM LANStreamer Adapter NDIS MAC device driver is required to support
  315.   multiple adapters.  Additional instances of the device driver statement in
  316.   CONFIG.SYS will be ignored.
  317.  
  318.   USER ACTION:  Remove the duplicate device driver statements from CONFIG.SYS.
  319.  
  320.   -----------------------------------------------------------------------------
  321.   LT60026E: THE REQUIRED PARAMETER DRIVERNAME WAS NOT FOUND IN PROTOCOL.INI.
  322.  
  323.   CAUSE:  The parameter specifying the driver name (DRIVERNAME) was
  324.   not found in PROTOCOL.INI.  This parameter is required.
  325.  
  326.   USER ACTION:  Change PROTOCOL.INI to specify the proper information.
  327.  
  328.   -----------------------------------------------------------------------------
  329.   LT60027E: THE PROTOCOL MANAGER COULD NOT BE OPENED.
  330.  
  331.   CAUSE:  An unexpected error occurred when the program attempted to
  332.   open the protocol manager.  The IBM LANStreamer Adapter NDIS MAC device
  333.   driver has been removed.
  334.  
  335.   USER ACTION:  Check the drive and directory to ensure that the protocol
  336.   manager is located in the specified path.
  337.  
  338.   -----------------------------------------------------------------------------
  339.   LT60028E: AN UNRECOVERABLE ERROR OCCURRED WHILE ATTEMPTING TO REGISTER THE
  340.             IBM LANSTREAMER ADAPTER NDIS DEVICE DRIVER PROGRAM WITH THE PROTOCOL
  341.             MANAGER.
  342.  
  343.   CAUSE:  The device driver was unable to register with the protocol
  344.   manager.
  345.  
  346.   USER ACTION:  Reinstall the protocol manager and try the operation again.
  347.  
  348.   -----------------------------------------------------------------------------
  349.   LT60029E: NO PHYSICAL ADAPTER WAS FOUND IN THIS MACHINE.
  350.  
  351.   CAUSE:  There was no adapter found in this machine.  An IBM LANStreamer
  352.   Adapter is required to run the MAC device driver.
  353.  
  354.   USER ACTION:  Install an IBM LANStreamer Adapter in this machine, or remove
  355.   the device driver statement from CONFIG.SYS.
  356.  
  357.   -----------------------------------------------------------------------------
  358.   LT60030W: THE UNRECOGNIZED PARAMETER 'PARAMETER NAME' WAS FOUND IN
  359.             PROTOCOL.INI.
  360.  
  361.   CAUSE:  An unrecognized parameter was found while processing the IBM
  362.   LANStreamer Adapter section of PROTOCOL.INI.
  363.  
  364.   USER ACTION:  Correct the parameter or remove it from PROTOCOL.INI.
  365.  
  366.   -----------------------------------------------------------------------------
  367.   LT60031W: THE VALUE SPECIFIED FOR NETWORK ADDRESS IN PROTOCOL.INI IS NOT
  368.             VALID.  THE BURNED-IN ADDRESS WILL BE SUBSTITUTED.
  369.  
  370.   CAUSE:  The value specified for the network address parameter in
  371.   PROTOCOL.INI is not correct for one of the following reasons:
  372.  
  373.   -   Invalid local station address
  374.   -   Too long
  375.   -   Too short
  376.   -   Contains non-hexadecimal characters
  377.   -   Not enclosed in double quotes
  378.  
  379.   USER ACTION:  Remove or correct the network address parameter (NETADDRESS).
  380.   A valid value for this parameter is 12 characters long, is enclosed in
  381.   double quotes, and contains only valid hexadecimal characters within the
  382.   range of 400000000000 through 7FFFFFFFFFFF.
  383.  
  384.   -----------------------------------------------------------------------------
  385.   LT60032I: IBM LANSTREAMER ADAPTER NDIS DEVICE DRIVER VERSION 'VERSION#'.
  386.  
  387.   CAUSE:  The version of the IBM LANStreamer device driver that is loaded
  388.   into memory is displayed in this message.
  389.  
  390.   USER ACTION:  None.
  391.  
  392.   -----------------------------------------------------------------------------
  393.   LT60033E: A DUPLICATE NETWORK ADDRESS WAS FOUND WHILE INSERTING ONTO THE RING.
  394.  
  395.   CAUSE:  The network address that the adapter wants to use on the
  396.   token-ring is being used by another node.
  397.  
  398.   USER ACTION:  Either modify PROTOCOL.INI to provide a different value for the
  399.   network address (NETADDRESS) parameter, use the default burned-in address,
  400.   or remove the other node that is using this network address from the ring.
  401.  
  402.   -----------------------------------------------------------------------------
  403.   LT60034E: RING FAILURE OR BEACONING WAS ENCOUNTERED WHILE INSERTING ONTO THE
  404.             RING.
  405.  
  406.   CAUSE: The ring speed is different from the speed of the node attempting
  407.   to insert onto the ring.
  408.  
  409.   USER ACTION: Use the reference diskette that came with your computer to ensure
  410.   that the adapter is configured at the same speed as the token-ring.
  411.  
  412.   -----------------------------------------------------------------------------
  413.   LT60035E: A HARDWARE FAILURE OCCURRED WHILE ATTEMPTING TO OPEN THE ADAPTER.
  414.  
  415.   CAUSE: When the adapter tried to insert onto the token-ring, a hardware
  416.   error occurred on the adapter.
  417.  
  418.   USER ACTION: Run the hardware diagnostics for the IBM LANStreamer Adapter.
  419.   Contact your vendor sales representative.
  420.  
  421.   -----------------------------------------------------------------------------
  422.   LT60036E: A LOBE MEDIA ERROR HAS OCCURRED.  ENSURE THAT THE TOKEN-RING
  423.             CABLE IS CONNECTED TO THE ADAPTER.
  424.  
  425.   CAUSE: While attempting to open the adapter, an indication was received
  426.   that the adapter is not properly connected to the token-ring.
  427.  
  428.   USER ACTION: Ensure that the token-ring cable is connected to the adapter
  429.   and to the token-ring multistation access unit (MAU).
  430.  
  431.   If the error persists, use a different token-ring cable and check to ensure
  432.   that the connection to the MAU is functioning properly.  Then run the
  433.   hardware diagnostics for the IBM LANStreamer Adapter.
  434.  
  435.   -----------------------------------------------------------------------------
  436.   LT60039I: INITIALIZATION STARTING FOR SECTION 'SECTION NAME' IN
  437.             PROTOCOL.INI.
  438.  
  439.   CAUSE:  The IBM LANStreamer NDIS device driver is processing the named
  440.   section of the PROTOCOL.INI file that is displayed in this message.
  441.  
  442.   USER ACTION:  None.
  443.  
  444.   -----------------------------------------------------------------------------
  445.   LT60044E: THE CONFIGURATION VALUES HAVE FORCED THE CONTROL-BLOCK SIZE TO
  446.             EXCEED THE AVAILABLE MEMORY.
  447.  
  448.   CAUSE: The configuration parameters specified require more space for
  449.   for processing than can be handled with the available system memory.
  450.  
  451.   USER ACTION: Reduce the value specified for the MAXTRANSMITS or MINRCVBUFFS
  452.   parameter to change the amount of storage required.
  453.  
  454.   The following formula can be used to compute the maximum value:
  455.  
  456.   H(i) = RCVAREA(i) + ALLOCSIZECB(i)
  457.  
  458.   A H(i) value should be computed for each IBM LANStreamer Adapter and the sum
  459.   of all H(i) values must be less than 1 MB.
  460.  
  461.   The receive area for each adapter can be computed:
  462.   RCVAREA = MINRCVBUFFS x SIZWORKBUF
  463.  
  464.   The control block area for each adapter can be computed using the following
  465.   formula and must be less than 64KB.
  466.   ALLOCSIZECB = 1698 + (190 * MAXTRANSMITS) + (256 * MINRCVBUFFS)
  467.  
  468.   -------------------------------------------------------------------------------
  469.  
  470.  
  471. IBM is a trademark of IBM, Inc.
  472. IBM LANStreamer Adapter is a trademark of IBM, Inc.
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.